﻿<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">

<head>
<meta http-equiv="Content-Language" content="en-us" />
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<title>This file describes how to modif</title>
</head>

<body>

<p>This file describes how to modify the QuickStart documentation.</p>
<p>An overview -- each documentation page as a file foo-source.html.&nbsp; When 
you run build.bat, it runs BuildQuickStart.exe on *-source.html, which does a 
couple things:</p>
<ul>
	<li>Creates foo-frames.html and foo-noframes.html versions of the source 
	page.</li>
	<li>Inserts samples wherever it sees %% filename.xaml%% in the source HTML.&nbsp; 
	Be inserted html will include the xaml, the JavaScript (if applicable), and 
	a &quot;preview&quot; jolt ActiveX control.</li>
	<li>For the frames version, creates a table of contents panel on the left 
	(basically, inserts NavigationPanel.html)</li>
	<li>Find any hyperlink pointing to *-source.html and replace it with *-frames.html 
	or *-noframes.html as appropriate.</li>
</ul>
<p>When you create a sample, put it in the samples directory and create a sample 
that can be run by itself.&nbsp; Remember that any functions and global 
variables you define in JavaScript should have unique names because when 
deployed to the quick start, your sample will be running alongside other 
samples.</p>
<p>Where to get the source for the quick starts: everything lives in the source 
depot provided by <a href="http://toolbox">http://toolbox</a>.&nbsp; To enlist:</p>
<ol>
	<li>md directory</li>
	<li>cd directory</li>
	<li>set sdport=BGIT-SDTOOLBOX:4001</li>
	<li>c:\nt\tools\x86\sd.exe client<br />
	<br />
	and set the view to:<br />
	<br />
	//depot/JoltQuickStartTools/... //MYMACHINENAME/...</li>
	<li>Look in the QuickStart subdirectory</li>
</ol>
<p>BuildQuickStart.exe supports the following %% constructs:</p>
<ul>
	<li>%% filename.xaml%% -- inserts samples\filename.Xaml and 
	samples\filename.js, along with a preview.&nbsp; If the JavaScript file is 
	empty, BuildQuickStart.exe won&#39;t display the script.&nbsp; 
	samples\filename.html should also exist so you can run your sample alone, 
	but BuiltQuickStart.exe pays no attention to it.</li>
	<li>%% filename.xaml showpreview=false %% -- starts with the sample&#39;s 
	preview hidden</li>
	<li>%%filename.xaml C#=mydir\myclass.cs%% -- displays C# code.&nbsp; The 
	JavaScript file is still assumed to exist.&nbsp; You&#39;ll need to manually 
	copy the sample&#39;s dll into the QuickStart directory.</li>
</ul>
<p>Make sure to put directives on their own line, in a paragraph by themselves, 
e.g.:</p>
<p>&lt;p&gt; %% filename.xaml%% &lt;/p&gt;</p>
<p>In theory, all %% directives are case-insensitive and ignore whitespace, but 
this hasn&#39;t been heavily tested.</p>
<p>Xaml, JavaScript, and C #files also support their own directives to control 
which text should be bold.&nbsp; Put the directive on its own line inside a 
comment (using the appropriate comment format for the source file), whitespace 
is not supposed to be significant.&nbsp; Supported directives:</p>
<font SIZE="2">
<ul>
	<li></font><font SIZE="2" COLOR="#008000">//emphasize sometext </font>-- 
	bolds the next occurrence of &quot;sometext&quot;.&nbsp; You can declare several 
	emphasized directives before any of the text to be emphasized occurs (which 
	is useful in XML, where you can&#39;t put comments inside elements)</li>
	<font SIZE="2" COLOR="#0000ff">
	<li>&lt;!--<font SIZE="2" COLOR="#008000">begin emphasis</font>--&gt;</font> -- 
	starting here, all lines will be bold until the end emphasis directed is 
	hit.&nbsp; These directives do not nest.&nbsp; </li>
	<font SIZE="2" COLOR="#0000ff">
	<li>&lt;!--<font SIZE="2" COLOR="#008000">end emphasis</font>--&gt;</li>
	<li>&lt;!--</font><font SIZE="2" COLOR="#008000"> begin collapsed</font><font SIZE="2" COLOR="#0000ff">--&gt;</font> 
	-- starting here, all lines will be hidden (not rendered) until the 
	corresponding end collapsed directive.&nbsp; These directives do not nest.</li>
	<font SIZE="2" COLOR="#0000ff">
	<li>&lt;!--</font><font SIZE="2" COLOR="#008000">end collapsed</font><font SIZE="2" COLOR="#0000ff">--&gt;</li>
</ul>
</font>
<p>Interesting files:</p>
<ul>
	<li>*-source.html -- are run through BuildQuickStart.exe.&nbsp; Make sure 
	&lt;/body&gt; is on a line by itself, as BuildQuickStart.exe inserts some things 
	right before this tag.</li>
	<li>*-frames.html -- generated by BuildQuickStart.exe</li>
	<li>*-noframes.html -- generated by BuildQuickStart.exe</li>
	<li>NavigationPanel.html -- BuildQuickStart.exe inserts this file into the 
	-frames version of -source.html files.&nbsp; BuildQuickStart.exe only 
	inserts things inside the &lt;body&gt; tag, the rest is ignored.&nbsp; Make sure 
	&lt;body&gt; is on a line by itself.</li>
	<li>FrameTemplate.html -- describes how *-source.html and 
	NavigationPanel.html should be combined into a single file</li>
	<li>samples\activex_template.html -- this HTML defines what the jolt preview 
	will look like for a sample.&nbsp; BuiltQuickStart.exe will insert this HTML 
	into *-source.html, once per sample.</li>
	<li>samples\per-page-template.html -- this HTML is inserted at the end of 
	every *-source.html file, right before the &lt;/body&gt; tag.</li>
	<li>stylesheet.css -- most of the look and feel as defined here, I tried to 
	write clean HTML.</li>
	<li>template\template.html -- used by NewJoltProject.exe</li>
	<li>template\template.js -- used by NewJoltProject.exe</li>
	<li>template\template.xaml -- used by NewJoltProject.exe</li>
</ul>
<p>&nbsp;</p>
<p>In general, these tools probably don&#39;t handle invalid xaml very well.</p>
<p>My HTML editor of choice is Expression Web.</p>

</body>

</html>
